[system] Introduce visuallyHidden style utility #21413
Merged
+135
−64
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
mnajdova
commented
Jun 13, 2020
|
@material-ui/system: parsed: +1.32% , gzip: +2.24% Details of bundle changes.Comparing: c4351c6...8807efc Details of page changes
|
mnajdova
changed the title
mnajdova
commented
Jun 13, 2020
packages/material-ui-lab/src/VisuallyHidden/VisuallyHidden.test.js
Outdated
Show resolved
Hide resolved
There was a problem hiding this comment.
It would be great to replace the existing usage of the styles in the components with this new abstraction:
- https://github.com/mui-org/material-ui/blob/70e7ba426b67bc6e589a18db22ad571e2c30f0c8/packages/material-ui-lab/src/Rating/Rating.js#L74-L85
- https://github.com/mui-org/material-ui/blob/70e7ba426b67bc6e589a18db22ad571e2c30f0c8/docs/src/pages/components/tables/EnhancedTable.tsx#L230-L240
While the component abstraction seems great for the table case, I believe the rating case would require to use the style directly (by-passing the component). What do you think of exposing a component and the underling styles in the public API?
Co-authored-by: Olivier Tassinari <[email protected]>
Co-authored-by: Olivier Tassinari <[email protected]>
Co-authored-by: Olivier Tassinari <[email protected]>
Co-authored-by: Olivier Tassinari <[email protected]>
mnajdova
commented
Jun 13, 2020
…erial-ui into fat/visually-hidden
mnajdova
commented
Jun 13, 2020
mnajdova
commented
Jun 13, 2020
mnajdova
changed the title
oliviertassinari
changed the title
| @@ -202,5 +202,7 @@ export const typography: SimpleStyleFunction< | |||
| >; | |||
| export type TypographyProps = PropsFor<typeof typography>; | |||
|
|
|||
| export const visuallyHidden: CSSProperties; | |||
There was a problem hiding this comment.
It sounds like the same problem than: #20379.
Suggested change
| export const visuallyHidden: CSSProperties; | |
| export const visuallyHidden: CSS.Properties; |
|
We have started a migration guide for v4 to v5 in https://github.com/mui-org/material-ui/blob/next/docs/src/pages/guides/migration-v4/migration-v4.md. (Oops, I have just noticed that the headers are wrong in this new page, to be fixed.) @mnajdova If you could update the markdown to include the |
oliviertassinari
approved these changes
Jun 14, 2020
eps1lon
approved these changes
Jun 16, 2020
There was a problem hiding this comment.
Other libraries offer this as a component, I guess for simplifying user scenarios.
I would need to see the use cases to be able to tell if this is actually simpler for users. The goal is not to "be simple" but to offer tools that make the correct default obvious: If a component makes it easy to use it standalone for invalid use cases then we failed. If we offer it as a style utility then it's obvious that it should be used in existing components such as Link.
In any case: We can always add a standalone component later instead of continuing the component prop pattern e.g. <Link className={classes.visuallyHidden} /> makes way more sense (and is easier to reason about) than <VisuallyHidden component={Link} />
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Breaking changes
srOnlyprop support with a style util:visuallyhiddentovisuallyHidden<Rating classes={{ - visuallyhidden: 'custom-visually-hidden-classname' + visuallyHidden: 'custom-visually-hidden-classname' }} />This PR adds the
visuallyHiddenstyle utility. It adds usages in theRatingcomponent and theEnhancedTableexamples. It also removes thesrOnlyvariant in theTypographyin favor of exporting this utility.Simple docs page is also added under the System section:
Edit @eps1lon: